Flesh out the documentaiton #130
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some pages are still skeletons or empty placeholders for now.
It now takes a text input file, which is easier to work with. It's more forgiving about comments and preceding `-` if you copy from a yaml file.
Contributor
Author
|
Need to add something about checksums and |
Contributor
Author
|
@andrewdnolan, I think this is done and ready for your final review. |
Contributor
Author
|
As we discussed, it might be best to not worry about getting every last detail right and just make sure there are no glaring holes for now. Then, we can revise it in subsequent PRs. It will be a lot more readable if it gets published to gh-pages. |
Collaborator
|
@xylar this looks great! I took a quick look over it and don't see any glaring holes. I had those few comments on the release candidate, since I was actively working off of that section yesterday. Just wanted to make note of those before I forgot. I think this is ready to be merged, it'll be great to have this rendered on gh-pages! |
Contributor
Author
|
Thank @andrewdnolan |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces extensive updates to the documentation for E3SM-Unified, focusing on improving user guidance, contributing processes, and technical details about deployment and release workflows. The changes are grouped into three main themes: user-facing documentation, contributing and community guidance, and technical documentation for maintainers.
User-Facing Documentation
README.md: Added a "Documentation" section with a link to the latest user and developer documentation.docs/index.md: Overhauled the documentation homepage to include an introduction to E3SM-Unified, a quickstart guide, and categorized links to other sections.docs/introduction.md: Introduced a detailed explanation of E3SM-Unified, its features, use cases, and supported platforms.docs/quickstart.md: Added a quickstart guide with activation commands for supported HPC systems, verification steps, and installation instructions for unsupported systems.Contributing and Community Guidance
docs/contributing.md: Added a comprehensive guide for contributing to E3SM-Unified, including ways to contribute, steps for submitting changes, and communication channels.Technical Documentation for Maintainers
docs/releasing/adding-new-machines.md: Added a guide for integrating new HPC machines into E3SM-Unified, including steps for updatingmacheand Spack configurations.docs/releasing/conda-vs-spack.md: Explained the hybrid Conda + Spack approach used in E3SM-Unified, detailing the rationale, architecture, and shared infrastructure.docs/releasing/creating-rcs/overview.md: Documented the process for creating release candidates for E3SM-Unified and its dependencies.docs/releasing/creating-rcs/rc-dependencies.md: Provided a step-by-step guide for creating RCs for dependency packages likee3sm_diagsandzppy.